/*
 *   Clovis
 *   Copyright (C) 2008 SFWOL
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __COLOR_H
#define __COLOR_H

#include "../core/CInteger.h"

namespace clovis {

	namespace video {

		/*!
		 * Color is a representation of a color on the screen. It is composed of reg (R), green (G), blue (B) and alpha (A) (transparency).
		 * \todo Add standard colors to the VideoDevice that coulb be used easily.
		 */
		class Color {

			private:

				core::CInteger red;
				core::CInteger green;
				core::CInteger blue;
				core::CInteger alpha;

			public:

				/*!
				 * Creates a new color with the given RGB(A) values.
				 */
				Color(core::CInteger red, core::CInteger green, core::CInteger blue, core::CInteger alpha = 0);

				/*!
				 * Return a lighter color, corresponding to the given color, with value, the intensity of the effect.
				 * \arg standard The "standard" color to proceed with.
				 * \return value The intensity of the modificatuion of the color.
				 */
				Color lighter(Color standard, core::CInteger value);

				/*!
				 * Return a darker color, corresponding to the given color, with value, the intensity of the effect.
				 * \arg standard The "standard" color to proceed with.
				 * \return value The intensity of the modificatuion of the color.
				 */
				Color darker(Color standard, core::CInteger value);

		};

	};

};

#endif
